Client Scripts

 

A Client script can access the Sym3 API and the .NET API.

 

To access the .NET API, call explicitly all .NET methods and object including the namespaces.

Example:

fs = System.IO.File.Open(path, System.IO.FileMode.OpenOrCreate, System.IO.FileAccess.Write);

 

To access the Sym3 API, the base object is Client (of type ISym3OperatorClient).

 

Currently supported Client variables are;

 
VariableDescription
%Client.Project.Name%Returns project name like 'Tmp123'
%Client.Project.Windows.Objects.Count%Returns '3' if you have 3 windows in your project
%Client.Alarms.IsConnected%Returns 'true' if the Alarm server is connected
 

A project demonstrating the use of these variable can be downloaded to show how they are defined and used.